Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CIP-0138? | Universal Query Layer #869

Open
wants to merge 26 commits into
base: master
Choose a base branch
from

Conversation

klntsky
Copy link
Contributor

@klntsky klntsky commented Aug 1, 2024

A transport-agnostic query layer specification for use in dApps and wallets.

See CPS-12 for motivation.

(rendered version)


Response:

- `TransactionUnspentOutput[]`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CIP-0116 defines this to include a TransactionOutput with this schema: https://github.com/cardano-foundation/CIPs/blob/b81611632f9dcea0b87d7d96cf673a720c77e929/CIP-0116/cardano-babbage.json#L445C6-L445C23

I would like to point out that chain data APIs seemingly do not decode the datum by default, i.e. when responding with transaction outputs.

I just stumbled over this yesterday in Hydra, which uses the cardano-api library to encode TxOuts and that results in a decoded datum mapped to json equivalence. See also our (messy, sorry) api reference: https://hydra.family/head-protocol/unstable/api-reference/#schema-TxOut

@rphair rphair changed the title CIP-XXXX | Universal Query Layer CIP-???? | Universal Query Layer Aug 1, 2024
@rphair rphair added the Category: Tools Proposals belonging to the 'Tools' category. label Aug 1, 2024
@rphair
Copy link
Collaborator

rphair commented Nov 7, 2024

thanks @nazrhom - editors note to also tag you on discussions related to this CIP.

@klntsky klntsky marked this pull request as ready for review November 7, 2024 16:41
Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @klntsky @nazrhom - marking Triage so this is officially brought into the review process at next CIP meeting (https://hackmd.io/@cip-editors/100) and my vote would be that a CIP number gets assigned there.

In the meantime we have to remove the bits of the CIP template scaffolding identified below:

CIP-XXXX/README.md Outdated Show resolved Hide resolved
CIP-XXXX/README.md Outdated Show resolved Hide resolved
CIP-XXXX/README.md Outdated Show resolved Hide resolved
CIP-XXXX/README.md Outdated Show resolved Hide resolved
CIP-XXXX/README.md Outdated Show resolved Hide resolved
CIP-XXXX/README.md Outdated Show resolved Hide resolved
CIP-XXXX/README.md Outdated Show resolved Hide resolved
CIP-XXXX/README.md Outdated Show resolved Hide resolved
@rphair rphair added the State: Triage Applied to new PR afer editor cleanup on GitHub, pending CIP meeting introduction. label Nov 8, 2024
@nazrhom
Copy link

nazrhom commented Nov 11, 2024

Thanks @rphair

CIP-XXXX/README.md Outdated Show resolved Hide resolved
@rphair rphair changed the title CIP-???? | Universal Query Layer CIP-0138? | Universal Query Layer Nov 14, 2024
Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@klntsky @nazrhom proposal well received & confirmed as candidate at last CIP meeting. Please remember to rename the proposal directory accordingly & update the README link in the original posting. 🎉

one question @nazrhom ... I had assumed the .json files here illustrative examples, but if they are implementation files (therefore likely to require maintenance beyond the CIP) the recommendation is to host them in a repository that you and/or implementors will maintain. Please confirm which category these are in (apologies if you've already done that & I missed it).

CIP-XXXX/README.md Outdated Show resolved Hide resolved
@rphair rphair added State: Confirmed Candiate with CIP number (new PR) or update under review. and removed State: Triage Applied to new PR afer editor cleanup on GitHub, pending CIP meeting introduction. labels Nov 14, 2024
Comment on lines +131 to +132
- [ ] There is at least one protocol adapter for any of the existing query layers that implements this spec, that can be run.
- [ ] There is at least one offchain library that implements a provider interface for this CIP, effectively making it usable with the protocol adapter in production.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be at least two. To show actual adoption across tooling. Otherwise we rapidly end up with 10 different Universal Query Layer (cf famous XKCD I don't need to link to because everyone knows what I am referring to).

Also, given the pre-existence of well established API query layers in the ecosystem already, I would definitely consider gathering maintainers around a table to discuss this. Standardization will likely not happen unless the top players commit to it as well.

Copy link
Collaborator

@rphair rphair Nov 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes & please also @klntsky @nazrhom invite any potential implementors you are aware of to participate via the "table" at the CIP Discord > #query-layer-standard (invite).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Tools Proposals belonging to the 'Tools' category. State: Confirmed Candiate with CIP number (new PR) or update under review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants